<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><title>Function Index - Bonfire</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="IndexPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.5 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Index><div class=IPageTitle>Function Index</div><div class=INavigationBar><a href="Functions.html#Symbols">$#!</a> &middot; 0-9 &middot; <a href="Functions.html#A">A</a> &middot; <a href="Functions.html#B">B</a> &middot; <a href="Functions.html#C">C</a> &middot; <a href="Functions2.html#D">D</a> &middot; <a href="Functions2.html#E">E</a> &middot; <a href="Functions2.html#F">F</a> &middot; <a href="Functions2.html#G">G</a> &middot; <a href="Functions2.html#H">H</a> &middot; <a href="Functions3.html#I">I</a> &middot; <a href="Functions3.html#J">J</a> &middot; K &middot; <a href="Functions3.html#L">L</a> &middot; <a href="Functions3.html#M">M</a> &middot; <a href="Functions3.html#N">N</a> &middot; <a href="Functions3.html#O">O</a> &middot; <a href="Functions3.html#P">P</a> &middot; <a href="Functions3.html#Q">Q</a> &middot; <a href="#R">R</a> &middot; <a href="#S">S</a> &middot; <a href="#T">T</a> &middot; <a href="#U">U</a> &middot; <a href="#V">V</a> &middot; <a href="#W">W</a> &middot; X &middot; <a href="#Y">Y</a> &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#read_config" id=link155 onMouseOver="ShowTip(event, 'tt151', 'link155')" onMouseOut="HideTip('tt151')" class=ISymbol>read_config</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#read_db_config" id=link156 onMouseOver="ShowTip(event, 'tt152', 'link156')" onMouseOut="HideTip('tt152')" class=ISymbol>read_db_config</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.redirect" id=link157 onMouseOver="ShowTip(event, 'tt153', 'link157')" onMouseOut="HideTip('tt153')" class=ISymbol>redirect</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/MY_date_helper-php.html#relative_time" id=link158 onMouseOver="ShowTip(event, 'tt154', 'link158')" onMouseOut="HideTip('tt154')" class=ISymbol>relative_time</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.remove_theme_path" id=link159 onMouseOver="ShowTip(event, 'tt155', 'link159')" onMouseOut="HideTip('tt155')" class=ISymbol>remove_theme_path</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.render" id=link160 onMouseOver="ShowTip(event, 'tt156', 'link160')" onMouseOut="HideTip('tt156')" class=ISymbol>render</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/controllers/users-php.html#Users.reset_password" id=link161 onMouseOver="ShowTip(event, 'tt157', 'link161')" onMouseOut="HideTip('tt157')" class=ISymbol>reset_password</a>, <span class=IParent>Users</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.restrict" id=link162 onMouseOver="ShowTip(event, 'tt158', 'link162')" onMouseOut="HideTip('tt158')" class=ISymbol>restrict</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/install/controllers/install-php.html#Install.rewrite_check" id=link163 onMouseOver="ShowTip(event, 'tt159', 'link163')" onMouseOut="HideTip('tt159')" class=ISymbol>rewrite_check</a>, <span class=IParent>Install</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.role_id" id=link164 onMouseOver="ShowTip(event, 'tt160', 'link164')" onMouseOut="HideTip('tt160')" class=ISymbol>role_id</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.role_name_by_id" id=link165 onMouseOver="ShowTip(event, 'tt161', 'link165')" onMouseOut="HideTip('tt161')" class=ISymbol>role_name_by_id</a>, <span class=IParent>Auth</span></td></tr><tr><td class=IHeading><a name="S"></a>S</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/modulebuilder/views/files/controller-php.html#save_{$module_name_lower}" id=link166 onMouseOver="ShowTip(event, 'tt162', 'link166')" onMouseOut="HideTip('tt162')" class=ISymbol>save_{$module_name_lower}</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.select" id=link167 onMouseOver="ShowTip(event, 'tt163', 'link167')" onMouseOut="HideTip('tt163')" class=ISymbol>select</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.send" id=link168 onMouseOver="ShowTip(event, 'tt164', 'link168')" onMouseOut="HideTip('tt164')" class=ISymbol>send</a>, <span class=IParent>Emailer</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.send_email" id=link169 onMouseOver="ShowTip(event, 'tt165', 'link169')" onMouseOut="HideTip('tt165')" class=ISymbol>send_email</a>, <span class=IParent>Emailer</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.set" id=link170 onMouseOver="ShowTip(event, 'tt166', 'link170')" onMouseOut="HideTip('tt166')" class=ISymbol>set</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.set_block" id=link171 onMouseOver="ShowTip(event, 'tt167', 'link171')" onMouseOut="HideTip('tt167')" class=ISymbol>set_block</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.set_date" id=link172 onMouseOver="ShowTip(event, 'tt168', 'link172')" onMouseOut="HideTip('tt168')" class=ISymbol>set_date</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.set_date_format" id=link173 onMouseOver="ShowTip(event, 'tt169', 'link173')" onMouseOut="HideTip('tt169')" class=ISymbol>set_date_format</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.set_default_theme" id=link174 onMouseOver="ShowTip(event, 'tt170', 'link174')" onMouseOut="HideTip('tt170')" class=ISymbol>set_default_theme</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/roles/models/role_permission_model-php.html#Role_permission_model.set_for_role" id=link175 onMouseOver="ShowTip(event, 'tt171', 'link175')" onMouseOut="HideTip('tt171')" class=ISymbol>set_for_role</a>, <span class=IParent>Role_permission_model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.set_message" id=link176 onMouseOver="ShowTip(event, 'tt172', 'link176')" onMouseOut="HideTip('tt172')" class=ISymbol>set_message</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.set_modified" id=link177 onMouseOver="ShowTip(event, 'tt173', 'link177')" onMouseOut="HideTip('tt173')" class=ISymbol>set_modified</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migrations_Class.set_path" id=link178 onMouseOver="ShowTip(event, 'tt174', 'link178')" onMouseOut="HideTip('tt174')" class=ISymbol>set_path</a>, <span class=IParent>Migrations Class</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.set_selects" id=link179 onMouseOver="ShowTip(event, 'tt175', 'link179')" onMouseOut="HideTip('tt175')" class=ISymbol>set_selects</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.set_soft_deletes" id=link180 onMouseOver="ShowTip(event, 'tt176', 'link180')" onMouseOut="HideTip('tt176')" class=ISymbol>set_soft_deletes</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.set_table" id=link181 onMouseOver="ShowTip(event, 'tt177', 'link181')" onMouseOut="HideTip('tt177')" class=ISymbol>set_table</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.set_theme" id=link182 onMouseOver="ShowTip(event, 'tt178', 'link182')" onMouseOut="HideTip('tt178')" class=ISymbol>set_theme</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migrations_Class.set_verbose" id=link183 onMouseOver="ShowTip(event, 'tt179', 'link183')" onMouseOut="HideTip('tt179')" class=ISymbol>set_verbose</a>, <span class=IParent>Migrations Class</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.set_view" id=link184 onMouseOver="ShowTip(event, 'tt180', 'link184')" onMouseOut="HideTip('tt180')" class=ISymbol>set_view</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.setup_session" id=link185 onMouseOver="ShowTip(event, 'tt181', 'link185')" onMouseOut="HideTip('tt181')" class=ISymbol>setup_session</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/install/controllers/install-php.html#Install.startup_check" id=link186 onMouseOver="ShowTip(event, 'tt182', 'link186')" onMouseOut="HideTip('tt182')" class=ISymbol>startup_check</a>, <span class=IParent>Install</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/address_helper-php.html#state_select" id=link187 onMouseOver="ShowTip(event, 'tt183', 'link187')" onMouseOut="HideTip('tt183')" class=ISymbol>state_select</a></td></tr><tr><td class=IHeading><a name="T"></a>T</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.theme" id=link188 onMouseOver="ShowTip(event, 'tt184', 'link188')" onMouseOut="HideTip('tt184')" class=ISymbol>theme</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.theme_url" id=link189 onMouseOver="ShowTip(event, 'tt185', 'link189')" onMouseOut="HideTip('tt185')" class=ISymbol>theme_url</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.theme_view" id=link190 onMouseOver="ShowTip(event, 'tt186', 'link190')" onMouseOut="HideTip('tt186')" class=ISymbol>theme_view</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/events-php.html#Events_Class.trigger" id=link191 onMouseOver="ShowTip(event, 'tt187', 'link191')" onMouseOut="HideTip('tt187')" class=ISymbol>trigger</a>, <span class=IParent>Events Class</span></td></tr><tr><td class=IHeading><a name="U"></a>U</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migration_Interface.up" id=link192 onMouseOver="ShowTip(event, 'tt188', 'link192')" onMouseOut="HideTip('tt188')" class=ISymbol>up</a>, <span class=IParent>Migration Interface</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>update</span><div class=ISubIndex><a href="../files/core/MY_Model-php.html#BF_Model.update" id=link193 onMouseOver="ShowTip(event, 'tt189', 'link193')" onMouseOut="HideTip('tt189')" class=IParent>BF_Model</a><a href="../files/core_modules/permissions/models/permission_model-php.html#Permission_model.update" id=link194 onMouseOver="ShowTip(event, 'tt190', 'link194')" onMouseOut="HideTip('tt190')" class=IParent>Permission_model</a><a href="../files/core_modules/roles/models/role_model-php.html#Role_model.update" id=link195 onMouseOver="ShowTip(event, 'tt191', 'link195')" onMouseOut="HideTip('tt191')" class=IParent>Role_model</a><a href="../files/core_modules/users/models/user_model-php.html#User_model.update" id=link196 onMouseOver="ShowTip(event, 'tt192', 'link196')" onMouseOut="HideTip('tt192')" class=IParent>User_model</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.update_where" id=link197 onMouseOver="ShowTip(event, 'tt193', 'link197')" onMouseOut="HideTip('tt193')" class=ISymbol>update_where</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.user_id" id=link198 onMouseOver="ShowTip(event, 'tt194', 'link198')" onMouseOut="HideTip('tt194')" class=ISymbol>user_id</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.user_name" id=link199 onMouseOver="ShowTip(event, 'tt195', 'link199')" onMouseOut="HideTip('tt195')" class=ISymbol>user_name</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.username" id=link200 onMouseOver="ShowTip(event, 'tt196', 'link200')" onMouseOut="HideTip('tt196')" class=ISymbol>username</a>, <span class=IParent>Auth</span></td></tr><tr><td class=IHeading><a name="V"></a>V</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/modulebuilder/controllers/developer-php.html#validate_form" id=link201 onMouseOver="ShowTip(event, 'tt197', 'link201')" onMouseOut="HideTip('tt197')" class=ISymbol>validate_form</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migrations_Class.version" id=link202 onMouseOver="ShowTip(event, 'tt198', 'link202')" onMouseOut="HideTip('tt198')" class=ISymbol>version</a>, <span class=IParent>Migrations Class</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/logs/controllers/developer-php.html#Logs_Developer_Context.view" id=link203 onMouseOver="ShowTip(event, 'tt199', 'link203')" onMouseOut="HideTip('tt199')" class=ISymbol>view</a>, <span class=IParent>Logs Developer Context</span></td></tr><tr><td class=IHeading><a name="W"></a>W</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.where" id=link204 onMouseOver="ShowTip(event, 'tt200', 'link204')" onMouseOut="HideTip('tt200')" class=ISymbol>where</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#write_config" id=link205 onMouseOver="ShowTip(event, 'tt201', 'link205')" onMouseOut="HideTip('tt201')" class=ISymbol>write_config</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#write_db_config" id=link206 onMouseOver="ShowTip(event, 'tt202', 'link206')" onMouseOut="HideTip('tt202')" class=ISymbol>write_db_config</a></td></tr><tr><td class=IHeading><a name="Y"></a>Y</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.yield" id=link207 onMouseOver="ShowTip(event, 'tt203', 'link207')" onMouseOut="HideTip('tt203')" class=ISymbol>yield</a>, <span class=IParent>Template</span></td></tr></table>
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt151"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function read_config(</td><td class=PParameter nowrap>$file,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$fail_gracefully</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>TRUE</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns an array of configuration settings from a single config file.</div></div><div class=CToolTip id="tt152"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function read_db_config(</td><td class=PParameter nowrap>$environment</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$new_db</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> NULL,</td></tr><tr><td></td><td class=PParameter nowrap>$fail_gracefully</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> TRUE</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Retrieves the config/database.php file settings. </div></div><div class=CToolTip id="tt153"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function redirect(</td><td class=PParameter nowrap>$url</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a javascript solution for page redirection. </div></div><div class=CToolTip id="tt154"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>if (</td><td class=PParameter nowrap>!function_exists('relative_time')</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Takes a UNIX timestamp and returns a string representing how long ago that date was, like &ldquo;moments ago&rdquo;, &ldquo;2 weeks ago&rdquo;, etc.</div></div><div class=CToolTip id="tt155"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function remove_theme_path(</td><td class=PParameter nowrap>$path</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt156"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function render(</td><td class=PParameter nowrap>$layout</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Renders out the specified layout, which starts the process of rendering the page content. </div></div><div class=CToolTip id="tt157"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function reset_password(</td><td class=PParameter nowrap>$email</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$code</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Allows the user to create a new password for their account. </div></div><div class=CToolTip id="tt158"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function restrict(</td><td class=PParameter nowrap>$permission</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$uri</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Checks that a user is logged in (and, optionally of the correct role) and, if not, send them to the login screen.</div></div><div class=CToolTip id="tt159"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private function rewrite_check()</td></tr></table></blockquote>Verifies that mod_rewrite is enabled as a PHP extension.</div></div><div class=CToolTip id="tt160"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function role_id()</td></tr></table></blockquote>Retrieves the role_id from the current session.</div></div><div class=CToolTip id="tt161"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function role_name_by_id(</td><td class=PParameter nowrap>$role_id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Retrieves the role_name for the request role.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt162"><div class=CFunction>Does the actual validation and saving of form data.</div></div><div class=CToolTip id="tt163"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function select(</td><td class=PParameter nowrap>$selects</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the select portion of the query in a chainable format. </div></div><div class=CToolTip id="tt164"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function send(</td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>array(),</td></tr><tr><td></td><td class=PParameter nowrap>$queue_override</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Handles sending the emails and routing to the appropriate methods for queueing or sending.</div></div><div class=CToolTip id="tt165"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>private function send_email(</td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$to</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$from</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$subject</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$message</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$alt_message</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sends the email immediately.</div></div><div class=CToolTip id="tt166"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function set(</td><td class=PParameter nowrap>$var_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Makes it easy to save information to be rendered within the views. </div></div><div class=CToolTip id="tt167"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function set_block(</td><td class=PParameter nowrap>$block_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$view_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Stores the block named $name in the blocks array for later rendering. </div></div><div class=CToolTip id="tt168"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>protected function set_date(</td><td class=PParameter nowrap>$user_date</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A utility function to allow child models to use the type of date/time format that they prefer. </div></div><div class=CToolTip id="tt169"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_date_format(</td><td class=PParameter nowrap>$format</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'int'</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the date_format to use for setting created_on and modified_on values.</div></div><div class=CToolTip id="tt170"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function set_default_theme(</td><td class=PParameter nowrap>$theme</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Stores the name of the default theme to use. </div></div><div class=CToolTip id="tt171"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_for_role(</td><td class=PParameter nowrap>$role_id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$permissions</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> array()</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the permissions for a single role.</div></div><div class=CToolTip id="tt172"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function set_message(</td><td class=PParameter nowrap>$message</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$type</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'info'</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets a status message (for displaying small success/error messages). </div></div><div class=CToolTip id="tt173"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_modified(</td><td class=PParameter nowrap>$modified</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>true</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether to auto-create modified_on dates in the update method.</div></div><div class=CToolTip id="tt174"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_path(</td><td class=PParameter nowrap>$path</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the base path that Migrations uses to find it&rsquo;s migrations to a user-supplied path. </div></div><div class=CToolTip id="tt175"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private function set_selects()</td></tr></table></blockquote>Takes the string in $this-&gt;selects, if not empty, and sets it with the ActiveRecord db class. </div></div><div class=CToolTip id="tt176"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_soft_deletes(</td><td class=PParameter nowrap>$soft</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>true</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether soft deletes are used by the delete method.</div></div><div class=CToolTip id="tt177"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_table(</td><td class=PParameter nowrap>$table</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Allows you to set the table to use for all methods during runtime.</div></div><div class=CToolTip id="tt178"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function set_theme(</td><td class=PParameter nowrap>$theme</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$default_theme</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Stores the name of the active theme to use. </div></div><div class=CToolTip id="tt179"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function set_verbose(</td><td class=PParameter nowrap>$state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This will set if there should be verbose output or not</div></div><div class=CToolTip id="tt180"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function set_view(</td><td class=PParameter nowrap>$view</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the current view to render.</div></div><div class=CToolTip id="tt181"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>private function setup_session(</td><td class=PParameter nowrap>$user_id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>0,</td></tr><tr><td></td><td class=PParameter nowrap>$username</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$password_hash</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$email</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$role_id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>0,</td></tr><tr><td></td><td class=PParameter nowrap>$remember</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false,</td></tr><tr><td></td><td class=PParameter nowrap>$old_token</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$user_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Creates the session information for the current user. </div></div><div class=CToolTip id="tt182"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private function startup_check()</td></tr></table></blockquote>Verifies that the folders and files needed are writeable. </div></div><div class=CToolTip id="tt183"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>if (</td><td class=PParameter nowrap>!function_exists('state_select')</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Creates a state/provience/county dropdown form input based on the entries in the address.states config. </div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt184"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static function theme()</td></tr></table></blockquote>Returns the active theme.</div></div><div class=CToolTip id="tt185"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function theme_url(</td><td class=PParameter nowrap>$resource</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the full url to a file in the currently active theme.</div></div><div class=CToolTip id="tt186"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function theme_view(</td><td class=PParameter nowrap>$view</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A shorthand method that allows views (from the current/default themes) to be included in any other view.</div></div><div class=CToolTip id="tt187"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function trigger(</td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>$event_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$payload</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Triggers an individual event.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt188"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public abstract function up()</td></tr></table></blockquote>Abstract method ran when increasing the schema version. </div></div><div class=CToolTip id="tt189"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Updates an existing row in the database.</div></div><div class=CToolTip id="tt190"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function update(</td><td class=PParameter nowrap>$id,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Update a particular permission from the database Remove it from role_permissions if set to inactive</div></div><div class=CToolTip id="tt191"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A simple update of the role. </div></div><div class=CToolTip id="tt192"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>array()</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt193"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update_where(</td><td class=PParameter nowrap>$field</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A convenience method that allows you to use any field/value pair as the &lsquo;where&rsquo; portion of your update.</div></div><div class=CToolTip id="tt194"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function user_id()</td></tr></table></blockquote>Retrieves the user_id from the current session.</div></div><div class=CToolTip id="tt195"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function user_name()</td></tr></table></blockquote>Retrieves the logged user&rsquo;s name. </div></div><div class=CToolTip id="tt196"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function username()</td></tr></table></blockquote>Retrieves the username from the current session.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt197"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>private function validate_form(</td><td class=PParameter nowrap>$field_total</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Handles the validation of the modulebuilder form.</div></div><div class=CToolTip id="tt198"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function version(</td><td class=PParameter nowrap>$version,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$type</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Migrate to a schema version.</div></div><div class=CToolTip id="tt199"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function view(</td><td class=PParameter nowrap>$file</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Shows the contents of a single log file.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt200"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function where(</td><td class=PParameter nowrap>$field</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the where portion of the query in a chainable format.</div></div><div class=CToolTip id="tt201"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function write_config(</td><td class=PParameter nowrap>$file</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$settings</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Saves the passed array settings into a single config file located in the /config directory.</div></div><div class=CToolTip id="tt202"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function write_db_config(</td><td class=PParameter nowrap>$settings</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Saves the settings to the config/database.php file.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt203"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static function yield()</td></tr></table></blockquote>Renders the current page into the layout.</div></div><!--END_ND_TOOLTIPS-->

</div><!--Index-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MTitle>Bonfire<div class=MSubTitle>Faster CodeIgniter Development</div></div><div class=MEntry><div class=MFile><a href="../files2/welcome-txt.html">Welcome to Bonfire</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Basic Info</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../files2/basic_info/requirements-txt.html">Server Requirements</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/license-txt.html">License Agreement</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/changelog-txt.html">Changelog</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/credits-txt.html">Credits</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Installation</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../files2/installation/installing-txt.html">Fresh Installation</a></div></div><div class=MEntry><div class=MFile><a href="../files2/installation/troubleshooting-txt.html">Troubleshooting Guide</a></div></div><div class=MEntry><div class=MFile><a href="../files2/installation/upgrading-txt.html">Upgrading</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Introduction</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../files2/introduction/getting_started-txt.html">Getting Started</a></div></div><div class=MEntry><div class=MFile><a href="../files2/introduction/overview-txt.html">Bonfire Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/introduction/concepts-txt.html">Important Concepts</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">General Topics</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../files2/general_topics/ajax-txt.html">AJAX in Bonfire</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/controllers-txt.html">Base Controllers</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/contexts-txt.html">Contexts Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/module_overview-txt.html">Modules Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/application_folder-txt.html">Moving the Application Folder</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/site_areas-txt.html">Site Areas</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/event_hooks-txt.html">System Events</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/auth_notes-txt.html">Understanding Authentication</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/unit_testing-txt.html">Unit Testing</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Core Modules</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="../files2/core_modules/activities-txt.html">Activities</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/database-txt.html">Database</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/emailer-txt.html">Emailer</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/logs-txt.html">Logs</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/migrations-txt.html">Migrations</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/permissions-txt.html">Permissions</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/roles-txt.html">Roles</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/tester-txt.html">Tester</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/ui-txt.html">UI</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Designers</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="../files2/designers/introduction-txt.html">Designer Introduction</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/views-txt.html">Views and Layouts</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/blocks-txt.html">Blocks</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/data-txt.html">Dynamic Data</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/flash-txt.html">Flash Messages</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/ajax-txt.html">Handling AJAX</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/utilities-txt.html">Template Utility Functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">Tutorials</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="../files3/todo-txt.html">ToDo Module</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Class Reference</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">Core Overrides</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="../files/core/MY_Model-php.html">BF_Model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core/MY_Controller-php.html">Controllers</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">Models</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/models/role_model-php.html">Role_model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/models/role_permission_model-php.html">Role_permission_model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/permissions/models/permission_model-php.html">Permission_model</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">Helpers</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="../files/helpers/address_helper-php.html">Address Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/application_helper-php.html">Application Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/MY_array_helper-php.html">Array Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/config_file_helper-php.html">Config File Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/MY_date_helper-php.html">MY_date_helper</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">Libraries</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="../files/libraries/assets-php.html">Assets</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/Console-php.html">Console</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/events-php.html">Events Class</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/template-php.html">Template</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Core Modules</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/models/activity_model-php.html">Activities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">Emailer</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="../files/core_modules/emailer/libraries/emailer-php.html">Emailer Library</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/emailer/controllers/settings-php.html">Emailer Settings Context</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/install/controllers/install-php.html">Install</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/logs/controllers/developer-php.html">Logs Developer Context</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/migrations/libraries/Migrations-php.html">Migrations</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Users</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="../files/core_modules/users/libraries/auth-php.html">Auth Library</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/users/controllers/users-php.html">Users Controller</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/users/models/user_model-php.html">User Model</a></div></div></div></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Bonfire</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Activities</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/controllers/activities-php.html">Activities</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/controllers/reports-php.html">Activities Reports Context</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/assets/js/jquery-dataTables-min-js.html">jquery.<wbr>dataTables.<wbr>min.js</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/views/reports/datatable_js-php.html">views/<wbr>reports/<wbr>datatable_js.php</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/modulebuilder/views/files/controller-php.html">modulebuilder/.../files/<wbr>controller.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/modulebuilder/controllers/developer-php.html">modulebuilder/<wbr>controllers/<wbr>developer.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/controllers/settings-php.html">roles/<wbr>controllers/<wbr>settings.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/subnav/controllers/subnav-php.html">subnav/<wbr>controllers/<wbr>subnav.php</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Index</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MIndex><a href="General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex id=MSelected>Functions</div></div><div class=MEntry><div class=MIndex><a href="Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="Files.html">Files</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([18], 19);// --></script></div><!--Menu-->


<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>